<?xml version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head><title>SASAPI</title><script src="../../../quicknav.js" type="text/javascript"></script><script><!--
document.quicknavBasePath="../../../index-files";
//--></script><link href="../../../style.css" title="JavaDoc" rel="stylesheet" type="text/css"/><link href="../../../unnatural.css" title="Unnatural" rel="alternate stylesheet" type="text/css"/><link href="../../../overview-summary.html" title="Overview" rel="top"/><meta name="generator" content="http://www.badgers-in-foil.co.uk/projects/as2api/"/></head><body><pre><span class="lineno" id="1">     1  </span><span class="comment doc">/**
<span class="lineno" id="2">     2  </span> * com.sekati.events.EventBroadcaster
<span class="lineno" id="3">     3  </span> * @version 1.0.1
<span class="lineno" id="4">     4  </span> * @author jason m horwitz | sekati.com
<span class="lineno" id="5">     5  </span> * Copyright (C) 2007  jason m horwitz, Sekat LLC. All Rights Reserved.
<span class="lineno" id="6">     6  </span> * Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
<span class="lineno" id="7">     7  </span> * 
<span class="lineno" id="8">     8  </span> * based on ca.nectere.events.Broadcaster
<span class="lineno" id="9">     9  </span> */</span>
<span class="lineno" id="10">    10  </span>
<span class="lineno" id="11">    11  </span><span class="key">import</span> com.sekati.core.CoreObject;
<span class="lineno" id="12">    12  </span><span class="key">import</span> com.sekati.core.KeyFactory;
<span class="lineno" id="13">    13  </span><span class="key">import</span> com.sekati.events.IEventBroadcastable;
<span class="lineno" id="14">    14  </span><span class="key">import</span> com.sekati.except.Catcher;
<span class="lineno" id="15">    15  </span><span class="key">import</span> com.sekati.except.IllegalOperationException;
<span class="lineno" id="16">    16  </span><span class="key">import</span> com.sekati.validate.TypeValidation;
<span class="lineno" id="17">    17  </span>
<span class="lineno" id="18">    18  </span><span class="comment doc">/**
<span class="lineno" id="19">    19  </span> * EventBroadcaster 
<span class="lineno" id="20">    20  </span> */</span>
<span class="lineno" id="21">    21  </span><span class="key">class</span> com.sekati.events.EventBroadcaster <span class="key">extends</span> CoreObject <span class="key">implements</span> IEventBroadcastable {
<span class="lineno" id="22">    22  </span>
<span class="lineno" id="23">    23  </span>	<span class="key">private</span> <span class="key">static</span> <span class="key">var</span> _instance:EventBroadcaster;
<span class="lineno" id="24">    24  </span>	<span class="key">private</span> <span class="key">var</span> _listeners:Array;
<span class="lineno" id="25">    25  </span>
<span class="lineno" id="26">    26  </span>	<span class="comment doc">/**
<span class="lineno" id="27">    27  </span>	 * Singleton Private Constructor.
<span class="lineno" id="28">    28  </span>	 * @return Void
<span class="lineno" id="29">    29  </span>	 */</span>
<span class="lineno" id="30">    30  </span>	<span class="key">private</span> <span class="key">function</span> EventBroadcaster() {
<span class="lineno" id="31">    31  </span>		<span class="key">super</span>( );
<span class="lineno" id="32">    32  </span>		_listeners = <span class="key">new</span> Array( );
<span class="lineno" id="33">    33  </span>	}
<span class="lineno" id="34">    34  </span>
<span class="lineno" id="35">    35  </span>	<span class="comment doc">/**
<span class="lineno" id="36">    36  </span>	 * Singleton Accessor.
<span class="lineno" id="37">    37  </span>	 * @return EventBroadcaster
<span class="lineno" id="38">    38  </span>	 */</span>
<span class="lineno" id="39">    39  </span>	<span class="key">public</span> <span class="key">static</span> <span class="key">function</span> getInstance():EventBroadcaster {
<span class="lineno" id="40">    40  </span>		<span class="key">if</span> (!_instance) _instance = <span class="key">new</span> EventBroadcaster( );
<span class="lineno" id="41">    41  </span>		<span class="key">return</span> _instance;
<span class="lineno" id="42">    42  </span>	}
<span class="lineno" id="43">    43  </span>
<span class="lineno" id="44">    44  </span>	<span class="comment doc">/**
<span class="lineno" id="45">    45  </span>	 * Shorthand Singleton accessor getter.
<span class="lineno" id="46">    46  </span>	 * @return EventBroadcaster
<span class="lineno" id="47">    47  </span>	 */</span>
<span class="lineno" id="48">    48  </span>	<span class="key">public</span> <span class="key">static</span> <span class="key">function</span> get $():EventBroadcaster {
<span class="lineno" id="49">    49  </span>		<span class="key">return</span> EventBroadcaster.getInstance( );	
<span class="lineno" id="50">    50  </span>	}
<span class="lineno" id="51">    51  </span>
<span class="lineno" id="52">    52  </span>	<span class="comment doc">/**
<span class="lineno" id="53">    53  </span>	 * Add an EventListener object
<span class="lineno" id="54">    54  </span>	 * @param o (Object)
<span class="lineno" id="55">    55  </span>	 * @param event (String)
<span class="lineno" id="56">    56  </span>	 * @param handler (Function)
<span class="lineno" id="57">    57  </span>	 * @return Void
<span class="lineno" id="58">    58  </span>	 */</span>
<span class="lineno" id="59">    59  </span>	<span class="key">public</span> <span class="key">function</span> addEventListener(o:Object, event:String, handler:Function):Void {
<span class="lineno" id="60">    60  </span>		<span class="key">var</span> index:Object = getIndex( o );
<span class="lineno" id="61">    61  </span>		<span class="key">if</span>( !_listeners[index] ) _listeners[index] = <span class="key">new</span> Array( );
<span class="lineno" id="62">    62  </span>		<span class="key">if</span>( !_listeners[index][event] ) _listeners[index][event] = <span class="key">new</span> Array( );
<span class="lineno" id="63">    63  </span>		_listeners[index][event].push( handler );
<span class="lineno" id="64">    64  </span>	}
<span class="lineno" id="65">    65  </span>
<span class="lineno" id="66">    66  </span>	<span class="comment doc">/**
<span class="lineno" id="67">    67  </span>	 * Remove an EventListener object
<span class="lineno" id="68">    68  </span>	 * @param o (Object)
<span class="lineno" id="69">    69  </span>	 * @param event (String)
<span class="lineno" id="70">    70  </span>	 * @param handler (Function)
<span class="lineno" id="71">    71  </span>	 * @return Void
<span class="lineno" id="72">    72  </span>	 */</span>
<span class="lineno" id="73">    73  </span>	<span class="key">public</span> <span class="key">function</span> removeEventListener(o:Object, event:String, handler:Function):Void {
<span class="lineno" id="74">    74  </span>		<span class="key">var</span> index:Object = getIndex( o );
<span class="lineno" id="75">    75  </span>		<span class="key">var</span> e:Array = _listeners[index][event];
<span class="lineno" id="76">    76  </span>		<span class="key">for</span>(<span class="key">var</span> i <span class="key">in</span> e) {
<span class="lineno" id="77">    77  </span>			<span class="key">if</span>(e[i] === handler) <span class="key">delete</span> _listeners[index][event][i];
<span class="lineno" id="78">    78  </span>		}
<span class="lineno" id="79">    79  </span>	}
<span class="lineno" id="80">    80  </span>
<span class="lineno" id="81">    81  </span>	<span class="comment doc">/**
<span class="lineno" id="82">    82  </span>	 * Remove all listeners and reset the broadcaster
<span class="lineno" id="83">    83  </span>	 * @return Void
<span class="lineno" id="84">    84  </span>	 */</span>
<span class="lineno" id="85">    85  </span>	<span class="key">public</span> <span class="key">function</span> reset():Void {
<span class="lineno" id="86">    86  </span>		_listeners = <span class="key">new</span> Array( );
<span class="lineno" id="87">    87  </span>	}
<span class="lineno" id="88">    88  </span>
<span class="lineno" id="89">    89  </span>	<span class="comment doc">/**
<span class="lineno" id="90">    90  </span>	 * Remove all listeners that are listening to a specific broadcaster
<span class="lineno" id="91">    91  </span>	 * @param o (Object)
<span class="lineno" id="92">    92  </span>	 * @return Void
<span class="lineno" id="93">    93  </span>	 */</span>
<span class="lineno" id="94">    94  </span>	<span class="key">public</span> <span class="key">function</span> removeAllFromBroadcaster(o:Object):Void {
<span class="lineno" id="95">    95  </span>		<span class="key">var</span> index:Object = getIndex( o );
<span class="lineno" id="96">    96  </span>		<span class="key">delete</span> _listeners[index];
<span class="lineno" id="97">    97  </span>	}
<span class="lineno" id="98">    98  </span>
<span class="lineno" id="99">    99  </span>	<span class="comment doc">/**
<span class="lineno" id="100">   100  </span>	 * Remove all listeners that are listening to a specific broadcaster and a specific event
<span class="lineno" id="101">   101  </span>	 * @param o (Object)
<span class="lineno" id="102">   102  </span>	 * @param event (String)
<span class="lineno" id="103">   103  </span>	 * @return Void
<span class="lineno" id="104">   104  </span>	 */</span>
<span class="lineno" id="105">   105  </span>	<span class="key">public</span> <span class="key">function</span> removeAllFromBroadcasterAndEvent(o:Object, event:String):Void {
<span class="lineno" id="106">   106  </span>		<span class="key">var</span> index:Object = getIndex( o );
<span class="lineno" id="107">   107  </span>		<span class="key">delete</span> _listeners[index][event];
<span class="lineno" id="108">   108  </span>	}
<span class="lineno" id="109">   109  </span>
<span class="lineno" id="110">   110  </span>	<span class="comment doc">/**
<span class="lineno" id="111">   111  </span>	 * Broadcast to all listeners (can accept extra args)
<span class="lineno" id="112">   112  </span>	 * @param o (Object)
<span class="lineno" id="113">   113  </span>	 * @param event (String)
<span class="lineno" id="114">   114  </span>	 * @return Void
<span class="lineno" id="115">   115  </span>	 */</span>
<span class="lineno" id="116">   116  </span>	<span class="key">public</span> <span class="key">function</span> broadcastEvent(o:Object, event:String):Void {
<span class="lineno" id="117">   117  </span>		broadcastArrayArgs( o, event, arguments.slice( <span class="num_const">2</span> ) );
<span class="lineno" id="118">   118  </span>	}
<span class="lineno" id="119">   119  </span>
<span class="lineno" id="120">   120  </span>	<span class="comment doc">/**
<span class="lineno" id="121">   121  </span>	 * Broadcast to all listeners (can accept extra args as array)
<span class="lineno" id="122">   122  </span>	 * @param o (Object)
<span class="lineno" id="123">   123  </span>	 * @param event (String)
<span class="lineno" id="124">   124  </span>	 * @param args (Array)
<span class="lineno" id="125">   125  </span>	 * @return Void
<span class="lineno" id="126">   126  </span>	 */</span>
<span class="lineno" id="127">   127  </span>	<span class="key">public</span> <span class="key">function</span> broadcastArrayArgs(o:Object, event:String, args:Array):Void {
<span class="lineno" id="128">   128  </span>		<span class="key">var</span> index:Object = getIndex( o );
<span class="lineno" id="129">   129  </span>		<span class="key">var</span> e:Array = _listeners[index][event];
<span class="lineno" id="130">   130  </span>		<span class="key">for</span>(<span class="key">var</span> i <span class="key">in</span> e) e[i].getFunction( ).apply( <span class="key">this</span>, args );
<span class="lineno" id="131">   131  </span>	}
<span class="lineno" id="132">   132  </span>
<span class="lineno" id="133">   133  </span>	<span class="comment doc">/**
<span class="lineno" id="134">   134  </span>	 * Gets index to use, and will inject key in object if needed
<span class="lineno" id="135">   135  </span>	 * This allows using objects or strings/numbers as channel for the broadcaster
<span class="lineno" id="136">   136  </span>	 * Will return either a number or a string
<span class="lineno" id="137">   137  </span>	 * @param o (Object)
<span class="lineno" id="138">   138  </span>	 * @return Object
<span class="lineno" id="139">   139  </span>	 */</span>
<span class="lineno" id="140">   140  </span>	<span class="key">private</span> <span class="key">function</span> getIndex(o:Object):Object {
<span class="lineno" id="141">   141  </span>		<span class="key">try</span> {
<span class="lineno" id="142">   142  </span>			<span class="key">if</span> (TypeValidation.isString( o ) || TypeValidation.isNumber( o )) {
<span class="lineno" id="143">   143  </span>				<span class="key">return</span> String( o );
<span class="lineno" id="144">   144  </span>			} <span class="key">else</span> <span class="key">if</span> (TypeValidation.isObject( o ) || TypeValidation.isMovieClip( o ) || TypeValidation.isFunction( o )) {
<span class="lineno" id="145">   145  </span>				<span class="key">return</span> KeyFactory.getKey( o );
<span class="lineno" id="146">   146  </span>			} <span class="key">else</span> {
<span class="lineno" id="147">   147  </span>				<span class="key">throw</span> <span class="key">new</span> IllegalOperationException( <span class="key">this</span>, <span class="str_const">"Unsupported broadcaster type (must be object, clip, function, string or number)."</span>, arguments );
<span class="lineno" id="148">   148  </span>			}
<span class="lineno" id="149">   149  </span>		} <span class="key">catch</span> (e:IllegalOperationException) {
<span class="lineno" id="150">   150  </span>			Catcher.handle( e );
<span class="lineno" id="151">   151  </span>		}
<span class="lineno" id="152">   152  </span>	}
<span class="lineno" id="153">   153  </span>}</pre><ul class="main_nav" id="main_nav"><li><a href="../../../overview-summary.html" title="Overview of SASAPI" class="button">Overview</a></li><li><a href="package-summary.html" title="Overview of package com.sekati.events" class="button">Package</a></li><li><a href="EventBroadcaster.html" title="Detail of com.sekati.events.EventBroadcaster API" class="button">Class</a></li><li><span class="button nav_current">Source</span></li><li><a href="../../../index-files/index.html" title="Alpabetical index of types and members" class="button">Index</a></li></ul><div class="footer"><a href="http://www.badgers-in-foil.co.uk/projects/as2api/" title="ActionScript 2 API Documentation Generator">as2api</a></div></body></html>